Scripting

ActiveXControls Name Description
Method Delete Delete the requested activexcontrol
Example
desklet.activexcontrols.delete(0)
Parameters
Name / Index String- The name of the activexcontrol you wish to delete
Method New Add new ActiveXControl
Example
desklet.ActiveXControls.new('Name','ShockwaveFlash.ShockwaveFlash.1',10,10,100,100,0)
Return: ActiveXControl
Parameters
Name String- The name of the ActiveXControl
ClassID String- The classid of the activexcontrol.. Refer to XML for more info
X Integer- X Position of the activexcontrol
Y Integer- Y Position of the activexcontrol
Width Integer- Width of the activexcontrol
Heigth Integer- Height of the activexcontrol
Side Byte- Side the layer will belong to
Property Count The number of activexcontrols in the desklet
Example
value = desklet.activexcontrols.count
Return: Integer
Property Item The name or index of the activexcontrols you wish to retrieve
Example
desklet.activexcontrols.item(0)
Return: ActiveXControl
Parameters
Name / Index String- The name of the activexcontrol you wish to get or the Index
ActiveXControl Name Description
Property Alpha Alpha blending value for the ActiveXControl (Note this might not be support on all systems)
Example
value = desklet.activexcontrols(0).Alpha
Return: Integer
Property BGColor Background color of the ActiveXControl
Example
value = desklet.activexcontrols(0).BGColor
Return: String
Property ComInt The com interface object of the ActiveXControl. This is where you can send commands to the ActiveXControl directly
Example
value = desklet.activexcontrols(0).ComInt.LoadMovie('test')
Return: OBJECT
Property Height Height of the ActiveXControl
Example
value = desklet.activexcontrols(0).Height
Return: Integer
Property Name Name of the activeXcontrol
Example
value = desklet.activexcontrols(0).Side
Return: Name - Readonly
Property Side Side the activexcontrol belongs to
Example
value = desklet.activexcontrols(0).Side
Return: Byte
Property TransparentColor The color used to represent the transparency of the ActiveXControl. (Note this is not support on all systems)
Example
value = desklet.activexcontrols(0).TransparentColor
Return: String
Property Visible Visibility of the activexform
Example
value = desklet.activexcontrols(0).Visible
Return: Boolean
Property Width Width of the ActiveXControl
Example
value = desklet.activexcontrols(0).Width
Return: Integer
Property X X position of the ActiveXControl
Example
value = desklet.activexcontrols(0).X
Return: Integer
Property Y Y position of the ActiveXControl
Example
value = desklet.activexcontrols(0).Side
Return: Integer
Brush Name Description
Method SetGradientPT1 Set the gradient first point
Example
layer.canvas.src.brush.setgradiantpt1(10,10)
Parameters
X Integer
Y Integer
Method SetGradientPT2 set the gradient second point
Example
layer.canvas.src.brush.setgradiantpt2(10,10)
Parameters
X Integer
Y Integer
Property Color The color of the brush
Example
value = layer.canvas.src.brush.color
Return: Integer
Property Image The image used if the brush type is pattern type. The image is the path to image
Example
value = layer.canvas.src.brush.image
Return: String
Property SecondColor The second color used if the brush type is gradient type
Example
value = layer.canvas.src.brush.secondcolor
Return: Pen
Property Brushtype The brush type used when calling the fill draw commands. 0 Solid, 1 Gradient, 2 Texture
Example
layer.canvas.src.brush.brushtype = 0
Return: Byte
CanvasList Name Description
Property src This will return the actual canvas object. This gives you control of the layer and all its "drawing" methods
Example
value = layer.canvas.src
Return: Canvas
Property dsrc This will return the actual canvas object. This gives you control of the layer and all its "drawing" methods
Example
value = layer.canvas.dsrc
Return: Canvas
Property msrc This will return the actual canvas object. This gives you control of the layer and all its "drawing" methods
Example
value = layer.canvas.msrc
Return: Canvas
Canvas Name Description
Method Clear Clear the entire layer.
Example
layer.canvas.src.clear()
Parameters
Color- opt Integer- Color of the layer after you clear it.
Method DrawArc Draw an arc
Example
layer.canvas.src.drawarc(10,10,20,20,10,10)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
StartAngle Short
SweepAngle Short
Method DrawBezier Draw a bezier
Example
layer.canvas.src.drawbezier(10,10,20,20,30,30,40,40)
Parameters
X1 Integer
Y1 Integer
X2 Integer
Y2 Integer
X3 Integer
Y3 Integer
X4 Integer
Y4 Integer
Method DrawEllipse Draw an ellipse
Example
layer.canvas.src.drawellipse(10,10,100,100)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
Method DrawImage Draw an image from a file.
Example
layer.canvas.src.drawimage('file',10,10,0,0,100,100)
Parameters
FileName String- The filename of the source you want to draw the image
X -opt Integer
Y-opt Integer
SX -opt Integer- Source X
SY -opt Integer- Source Y
SWidth -opt Integer- Source Width
SHeight -opt Integer- Source height
Method DrawLine Draw a line from 1 point to another
Example
layer.canvas.src.drawline(1,1,10,10)
Parameters
X1 Integer
Y1 Integer
X2 Integer
Y2 Integer
Method DrawPie Draw a pie object
Example
layer.canvas.src.drawpie(20,20,5,5,0,0)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
StartAngle Short
SweepAngle Short
Method DrawRectangle Draw a rectangle
Example
layer.canvas.src.drawrectangle(10,10,100,100)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
Method DrawText Draw a text
Example
layer.canvas.src.drawtext('Hello',0,10,100,20)
Parameters
Text String-The text that will be drawn
X Integer
Y Integer
Width Integer
Height Integer
Method FillEllipse Draw an filled ellipse
Example
layer.canvas.src.fillellipse(10,10,100,100)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
Method FillPie Draw a filled pie object
Example
layer.canvas.src.fillpie(20,20,5,5,0,0)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
StartAngle Short
SweepAngle Short
Method FillRectangle Draw a rectangle that is filled
Example
layer.canvas.src.fillrectangle(10,10,100,100)
Parameters
X Integer
Y Integer
Width Integer
Height Integer
Method GetPixel Get the color of the pixel at X,Y
Example
value = layer.canvas.src.getpixel(10,10)
Return: Integer- Color
Parameters
X Integer
Y Integer
Method SetPixel Set the color of a pixel at X,Y
Example
layer.canvas.src.setpixel(10,10,color)
Parameters
X Integer
Y Integer
Color Integer- Integer value of the color. Use StrToColor to get the color you want.
Property Brush This will give you access to the Brush object for the canvas. Brush is used for the fill in commands
Example
value = layer.canvas.src.brush
Return: Brush
Property Font This will give you access to the Font object for the canvas
Example
value = layer.canvas.src.font
Return: Font
Property Pen This will give you access to the Pen object for the canvas. The pen is used for drawing the outline of all draw commands
Example
value = layer.canvas.src.pen
Return: Pen
CMDExecute Name Description
Method Start Start the CMD execute command that was created.
Example
cmdobj.Start()
Method Stop Stop the CMD execute command that was previously started. Stopping means that the entire process is unloaded.
Example
cmdobj.Stop()
Method SendInput Send the input string to the active cmd process
Example
cmdobj.SendInput('A')
Parameters
Value String- The of the input for the command process. The string does not include CR (Carriage Returns) or LF (LineFeeds)
Controls Name Description
Method Delete Delete the requested control
Example
desklet.Controls.Delete(0)
Parameters
Name / Index String- The name of the control you wish to delete
Method New Add new Control
Example
desklet.controls.new('name','EDITBOX',10,10,0)
Return: Control
Parameters
Name String- The name of the control
CtrlType String- The control type you wish to create. Refer to the xml to get the list of control types
X Integer- X Position of the control
Y Integer- Y Position of the control
Side Byte- Side the control will belong to
Property Count The number of controls in the desklet
Example
value = desklet.controls.count
Return: Integer
Property Item The name of the control you wish to retrieve
Example
value = desklet.controls.count
Return: String
Parameters
Name / Index String- The name of the control you wish to get or the Index
Control Name Description
Method GetSelDisplayValue Get the selected display value for a given index
Example
value = control.GetSelDisplayValue(1)
Return: String
Parameters
Idx Integer- The index of the selected list that you wish to get the display value for
Method GetSelectValue Get the selected value for a given index
Example
value = control.GetSelectValue(1)
Return: String
Parameters
Idx Integer- The index of the selected list that you wish to get the value for
Method LockUpdates This will stop all update changes from performing a update on the screen. Allows the user to set more than 1 property and then do 1 redraw afterwards
Example
control.LockUpdates
Method Redraw Redraw the control with current settings
Example
control.Redraw()
Method SetScrollThumbSize Set the scroller thumb size.
Example
control.SetScrollThumbSize(10,100)
Parameters
Visible Integer- This is the size of the visible scroll bar size
Total-Opt Integer- This is the total scroll size. By default, it will determine the max size.
Method UnlockUpdates Sets the updates back to default state. All layer changes cause a redraw of the controls.
Example
control.unlockupdates()
Property CtrlType The type of the control
Example
value = control.Ctrltype
Return: String (readonly)
Property CtrlSide The side which the control belongs to.
Example
value = control.CtrlSide
Return: Byte
Property Display The display value for the control
Example
value = control.Display
Return: String
Property FontBGColor Background FontColor used if the control has text. This can be represented as a RGB or "Delphi" color names. #FF000 would be the RGB value for Red
Example
control.FontBGColor = 'clred'
Return: String
Property FontColor FontColor used if the control has text. This can be represented as a RGB value or "Delphi" color names. #FF000 would be the RGB value for Red
Example
control.FontColor = 'clred'
Return: String
Property FontName FontName used if the control has text
Example
control.FontName = 'Arial'
Return: String
Property FontSize FontSize used if the control has text
Example
control.FontSize = 6
Return: Integer
Property FontStyle FontStyle used if the control has text (B bold, I italic U underline, S strike-out)
Example
control.FontStyle = 'BU'
Return: Integer
Property Height Height of the control
Example
control.Height = 12
Return: Integer
Property Index Index of the drop down control.
Example
control.Index = 1
Return: Integer
Property ListValues The list of values used for a drop down. Each item defined by display=value comma delimitted.
Example
control.ListValues = '°C=m;°F=i' //This will set the value C and F to be displayed in the ist box, but with the value M and I
Return: String
Property Name Name of the control
Example
value =control.name
Return: String (readonly)
Property NewIndex Readonly- Select index for the drop down control that is about to be changed.
Example
value = control.NewIndex
Return: Integer
Property Password Set the control to password mode (text)
Example
control.Password = true
Return: Bool
Property Readonly Set the control to read-only
Example
control.ReadOnly = true
Return: Bool
Property ScrollbarSize Set the max value for the scrollbar
Example
control.ScrollbarSize = 10
Return: Integer
Property Width Width of the control
Example
control.Width = 10
Return: Integer
Property Value The value for the control
Example
control.value = 'Value'
Return: String
Property Visible Visible state of the control
Example
control.visible = true
Return: Bool
Property X X Position of the control
Example
control.X = 10
Return: Integer
Property Y Y Position of the control
Example
control.Y = 10
Return: Integer
Event OnChange Event fired when the value of the control has changed
Example
control.OnChange = 'alert("On Change")'
Event OnEnter Event fired when control gets focused
Example
control.OnChange = 'alert("On Enter")'
Event OnExit Event fired when control loses focus
Example
control.OnChange = 'alert("On Exit")'
Event OnKeyEnter Event fired when the keyboard ENTER key has been pressed
Example
control.OnChange = 'alert("On Key Enter")'
Desktop Name Description
Property Left Left Pixel location of the desktop
Example
value = desklet.UI.desktop.Left
Return: Integer - Readonly
Property Height Height of the desktop
Example
value = desklet.UI.desktop.height
Return: Integer - Readonly
Property Top Top pixel of the desktop
Example
value = desklet.UI.desktop.top
Return: Integer - Readonly
Property Width Width of the desktop
Example
value = desklet.UI.desktop.width
Return: Integer - Readonly
Property WorkHeight Work area height of the desktop
Example
value = desklet.UI.desktop.workheight
Return: Integer- Readonly
Property WorkLeft Work area left pixel of the desktop
Example
value = desklet.UI.desktop.workleft
Return: Integer- Readonly
Property WorkTop Work area top pixel of the desktop
Example
value = desklet.UI.desktop.worktop
Return: Integer- Readonly
Property WorkWidth Work area width of the desktop
Example
value = desklet.UI.desktop.workwidth
Return: Integer- Readonly
Desklet Name Description
Method alert display a message box
Example
desklet.alert('Hello World')
Parameters
strMsg String- Value containing the message to be displayed
Method BringToFront Makes the desklet come to the front of the windows.
Example
desklet.BringToFront()
Method ConvertToValue This will return a string value with all parameters inserted in the passed value. Parameters are all represented by %%. Example: %TEST%
Example
val = desklet.ConvertToValue('This is the param value: %PARAM% with the desktop path %MYDESKTOP%')
Return: String
Parameters
Value String- This is the string value with parameter variables.
Method Close Close the desklet
Example
desklet.Close()
Parameters
Prompt (opt) Boolean- Prompt if for user to confirm the closing of the desklet.
Method CreateObject Create ole object
Example
comobj = desklet.CreateObject('TEST.TEST', 'TST_') // This will create the test.test object all functions starting with TST_ will be bound to the object. In otherwords, if the com interface has an open event you would need to create a tst_open functions with the correct parameters.
Return: ComObject
Parameters
ProgID String- Program ID CLSID
EventPrefix (opt) String- Event Prefix is the prefix used for callback events
Autocreate (opt) Boolean- Autocreate the comobject or try to get the current running com. Default is true.
Method ConnectObject This will connect the selected com object events to the desklet. The prefix is used to determine what script to call. Similar to createobject.
Example
desklet.ConnectObject(obj,'tst_')
Parameters
Obj ComObject- ComObject that you want to bind it to.
EventPrefix String- The event prefix used for callback events.
Method DeskletFadeIn Will trigger the avedesk animation which makes the desklet fade in.
Example
desklet.DeskletFadeIn(false,1000)
Parameters
Async Boolean- Async or not. Does the command pause till the fade is done or continue.
Time Integer- Time in MS needed to complete the fade
Method DeskletFadeout Will trigger the avedesk animation which makes the desklet fade out.
Example
desklet.DeskletFadeIn(false,1000)
Parameters
Async Boolean- Async or not. Does the command pause till the fade is done or continue.
Time Integer- Time in MS needed to complete the fade
Method DisconnectObject Disconnects the Com/ActiveX object from the events.
Example
desklet.DisconnectObject(obj)
Parameters
Obj ComObject- ComObject that you want to disconnect.
Method EnableTimers Cause all the timers defined in the current desklet to either stop or restart.
Example
desklet.EnableTimers(true)
Parameters
Enable Bool- True to start / False to stop
Method ExecuteFunction This will execute the a procedure and receive the result from the desklet. This can be execute by another desklet.
Example
desklet.ExecuteFunction('test','param1')
Parameters
FunctionName String- The name of the function that will be executed.
Param1 Variant-opt Optional parameter that can be passed to the function.
Param2 Variant-opt Optional parameter that can be passed to the function.
Param3 Variant-opt Optional parameter that can be passed to the function.
Param4 Variant-opt Optional parameter that can be passed to the function.
Param5 Variant-opt Optional parameter that can be passed to the function.
Method ExecuteScript This will execute the string parameter in the desklet. Allowing other deskets to execute scripts in another desklet.
Example
desklet.executescript('alert("D"))
Parameters
Script String- The script/code that you wish to be executed on the desklet.
Method FlipTo Flip the desklet to another side
Example
desklet.FlipTo(1)
Parameters
Side Integer- The side you want the desklet to flip to.
Method ForceXDataFetch This will force the desklet to get all XData
Example
desklet.ForceXDataFetch(true)
Parameters
ForceConnect (opt) Boolean- Force a connection to the internet if none is active. Default is false.
Method GetAveScripterVersion Get the AveScripter Version number. This is format like so. 1000005010, this would represet version 1.0.5.10.
Example
desklet.GetAveScripterVersion()
Return: Integer
Method GetActiveLayer Get the active layer for any triggered event.
Example
ly = desklet.GetActiveLayer()
Return: Layer
Method GetChangeToSide Get the side that we are about to change to. This is usually used onbeforeflip.
Example
Value = desklet.GetChangeToSide()
Return: Integer
Method GetCurrentSide This will get the current side ID for the desklet.
Example
value = desklet.GetCurrentSide()
Return: Integer
Method GetDroppedFileName This will get the file name of the dropped file on the desklet. Triggered by the ondropfile event
Example
value = desklet.GetDroppedFileName()
Return: String
Method GetKeyStr Get the keyboard string value that was pressed onkeypress
Example
value = desklet.GetKeyStr()
Return: String
Method GetKeyVal Get the keyboard byte value that was pressed onkeypress This is the ascii value of the key. Example 13 = enter
Example
value = desklet.GetKeyVal()
Return: Integer
Method GetLayerAtXY This will return the layer at X, Y position in the desklet.
Example
value = desklet.GetLayerAtXY(10,10)
Return: Layer
Parameters
X Integer- The X Position.
Y Integer- The Y Position.
Method GetLayerMouseXPos This will return the mouse X position for the last event (All mouse events on the desklet)
Example
value = desklet.GetLayerMouseXPos()
Return: Integer
Method GetLayerMouseYPos This will return the mouse Y position for the last event (All mouse events on the desklet)
Example
value = desklet.GetLayerMouseXPos()
Return: Integer
Method GetMouseScrollValue This will return the scroll value used in the last mouse scroll event (for all mouse events on the desklet/layer)
Example
value = desklet.GetMouseScrollValue();
Return: Integer
Method GetMouseXPos This will return the mouse X position for the last event (All mouse events on the layer)
Example
value = desklet.GetMouseXPos()
Return: Integer
Method GetMouseYPos This will return the mouse Y position for the last event (All mouse events on the layer)
Example
value = desklet.GetMouseYPos()
Return: Integer
Method GetParamValue Return the value for a given parameter name
Example
val = desklet.GetParamValue('ParamName')
Return: String
Parameters
ParamName String- Name of the parameter
Method GetShiftState Return the state of the shift,ctrl,alt key
Example
val = desklet.GetShiftState
Return: Byte- 1 shift 2 ctrl key 4 alt key
Method Invalidate This will invalidate the desklet. A Invalidate is very similar to a refresh.
Example
desklet.Invalidate(true)
Parameters
Full (opt) Boolean- This will force a invalidate on the desklet. Default is full invalidate, othewise only pending invalidates.
Method IsConnectedToInternet This will check if the desklet currently has internet access.
Example
value = desklet.IsConnectedToInternet()
Method LoadScriptDesklet This will load a new AveScripter desklet from the config file.
Example
desklet.LoadScriptDesklet('sample.avedesklet')
Return: Desklet- The return object is the desklet.
Parameters
ConfigFile String- The file name of the config file. The file must be an avedesklet extension. To create on use the export feature in the control panel.
Visible Boolean- opt Show the desklet visible or not once created.
Method LockAllUpdates Stop the desklet from creating any layer redraw updates.
Example
desklet.LockAllUpdates()
Method MultiMedia This will play the filename (wave file)
Example
desklet.MultiMedia('beep.wav', 2) //this will cause the desklet to play the beep sound over and over desklet.MultiMedia('', 0) // stop the sound
Parameters
FileName String- Path of the file to play
Command Byte- Command to execute 0 - Stop, 1 - Play sound, 2-Play Sound Looped, 3-Play Sound, and wait until it's done
Method PopupMenu Popup a created menu at mouse location.
Example
desklet.PopupMenu(1)
Parameters
MenuID Integer- The ID of the menu you want to display.
Method Redraw Redraw all the layers on the desklet. Calling this command will force the desklet to redraw ALL the layers again.
Example
desklet.Redraw(true)
Parameters
XMLOnly (opt) Boolean- Only redraw XML bound layers
Method Refresh Refresh will cause the desklet to be drawn again. This will only cause the desklet to be redrawn, not the layers.
Example
desklet.Refresh()
Method SetSubLabel This will set the sublabel for the desklet
Example
desklet.SetSubLabel('Sub label text')
Parameters
Value String- The sublabel text
Method SetWidthHeight Set the Width and Height of the desklet.
Example
desklet.SetWidthHeight(100,200)
Parameters
Width Integer- Width of the desklet
Heigth Integer- Height of the desklet
Method SetXYPos Set the X and Y Position of the desklet.
Example
desklet.SetXYPos(10,10)
Parameters
X Integer- X Position of the desklet
Y Integer- Y Position of the desklet
Method Sleep Cause the desklet to sleep/wait X milliseconds.
Example
desklet.Sleep(1000) this will cause the desklet to sleep 1000 ms which is equal to 1 sec.
Parameters
Value Integer- The number of Milliseconds
Method UnLockAllUpdates Unlock all the updates to the desklet, setting it back to normal. All redraws will now work correctly.
Example
desklet.UnLockAllUpdates()
Method SendToBack Sends the desklet to the back of all windows.
Example
desklet.SendToBack()
Method SetVisible Set the desklet visible or not
Example
desklet.SetVisible(true)
Parameters
Value Boolean- True / Visible or False / Hide
Property ActiveXControls Contains the list of ActiveXControls
Example
value = desklet.ActiveXControls('FLASH')
Return: ActiveXControls, You can get the controls by index or by activexcontrol name
Property AveDesk Get the com engine of AveDesk.
Example
desklet.alert(desklet.avedesk.RunningDesklets.Count)
Return: AveDesk Engine.
Property Controls Contains the list of controls
Example
value = desklet.Controls('Name')
Return: Controls, You can get the controls by index or by name of the control
Property DeskletAlpha Alpha value of the desklet
Example
desklet.DeskletAlpha(10)
Return: Byte
Property DeskletLabel Label of the desklet
Example
desklet.DeskletLabel('Label')
Return: String
Property DeskletHeight Height of the desklet
Example
desklet.DeskletHeight(100)
Return: Integer
Property DeskletRotation Rotation of the desklet
Example
desklet.DeskletRotation(10)
Return: Integer
Property DeskletWidth Width of the desklet
Example
desklet.DeskletWidth(100)
Return: Integer
Property DeskletXPos X Position on the screen for the desklet
Example
desklet.DeskletXPos(10)
Return: Integer
Property DeskletYPos Y Position on the screen for the desklet
Example
desklet.DeskletYPos(10)
Return: Integer
Property HotKeys This will return the list of HotKeys
Example
value = desklet.HotKeys
Return: HotKeys
Property IDESKLET This will return the IDESKLET Com interface from AveDesk
Example
value = desklet.IDesklet
Return: IDesklet
Property IO This will return the IO object.
Example
value = desklet.IO
Return: IO
Property Layers Contains the list of layers
Example
value = desklet.Layers('Name')
Return: Layers, You can get the layers by Index or by name of the layer.
Property Menus This will return the Menus used in the desklet.
Example
value = desklet.Menus(1)
Return: Menus, You can get the menu item by index.
Property Parameters Contains the list of parameters
Example
value = desklet.Parameter('Name')
Return: Parameters, You can get the parameter by index or by name
Property PlugIns Contains the list of PlugIns's
Example
value = desklet.Plugins('test')
Return: PlugIns, You can get the plugin by name
Property Sides Contains the list of sides
Example
value = desklet.Sides(1)
Return: Sides, You can get the side by index.
Property SkinName Name of the desklet skin
Example
value = desklet.SkinName()
Return: String (readonly)
Property Timers Contains the list of timers
Example
value = desklet.Timers('TimerName')
Return: Timers, You caan get the timer by index or by name.
Property UI This will return the UI object.
Example
value = desklet.UI
Return: UI
Property VISIBLE Set or read the desklet visible state.
Example
value = desklet.UI
Return: Boolean
Property XMLS Contains the list of XMLS's
Example
value = desklet.XMLS(1)
Return: XMLS, You can get the xml by the Index of the xml.
Event OnAfterFlip Event fired after the flipping of the desklet is done
Example
desklet.OnAfterFlip('alert("on After Flip"))
Event OnBeforeFlip Event fired before the flipping of the desklet occurs
Example
desklet.OnBeforeFlip('alert("before flip"))
Event OnCharDown Event fired when a keyboard char key is pressed and not a special key, while the desklet is selected.
Example
desklet.OnCharDown('alert("on key down"))
Event OnCreate Event fired when the desklet is being created
Example
desklet.OnCreate('alert("test")')
Event OnDeselect Event fired when the desklet is unselected.
Example
desklet.OnDeselect('alert("on deselect"))
Event OnDestroy Event fired when the desklet is being destroyed/removed
Example
desklet.OnDestroy('alert("destroy"))
Event OnDropFile Event fired when a file is being dropped on the desklet
Example
desklet.OnDropFile('alert("On Drop File"))
Event OnKeyDown Event fired when a keyboard key is pressed while the desklet is selected.
Example
desklet.OnKeyDown('alert("on key down"))
Event OnMouseEnter Event fired when the mouse cursor enters the desklet
Example
desklet.OnMouseEnter('alert("On Mouse Enter"))
Event OnMouseExit Event fired when the mouse cursor exits the desklet
Example
desklet.OnMouseExit('alert("On Mouse Exit"))
Event OnMouseMove Event fired when the mouse cursor is moving on the desklet
Example
desklet.OnMouseMove('alert("Mouse Move"))
Event OnMouseScroll Event fired when the mouse scroller is triggered while the mouse is over the desklet.
Example
desklet.OnMouseScroll('alert("Mouse Scroll"))
Event OnSelect Event fired when the desklet is selected
Example
desklet.OnSelect('alert("On Select"))
Font Name Description
Property FontIsAA Set the font as to be AntiAliasing or not
Example
layer.canvas.src.font.fontisaa = true
Return: Boolean
Property FontAlignment Set the font alignment. Refer to the XML for the font alignment parameters that can be used.
Example
value = layer.canvas.src.font.fontalignment = 'L'
Return: Pen
Property FontName The name of the font
Example
value = layer.canvas.src.font.fontname
Return: String
Property FontSize Font Size used
Example
value = layer.canvas.src.font.fontsize = 10
Return: Integer
Property FontStyle Set the font style. Refer to the XML for font style parameters that can be used.
Example
layer.canvas.src.fontstyle = 'B'
Return: String
HotKeys Name Description
Method Delete Delete the requested HotKeys
Example
desklet.HotKeys.Delete(0)
Parameters
Index Integer- The index of the hotkey
Method New Add New Hotkey
Example
desklet.HotKeys.New(173,'A','alert('hotkey'))
Return: HotKey
Parameters
Key Integer- Ascii key
ShiftKey String- Shift Key modifier need to trigger hot key. ('A' Alt key, 'C' Ctrl, 'S' Shift, 'W' Windows key)
Script String- The script triggered when the hot key is triggered
Property Count The number of HotKeys in the desklet
Example
value = desklet.HotKeys.count
Return: Integer
Property Item The index of the HotKey you wish to retrieve
Example
desklet.HotKey.item(0)
Return: HotKey
Parameters
Index Integer- The index of the hotkey
HotKey Name Description
Property Key The key bound to the hotkey
Example
value = desklet.HotKeys(0).Key
Return: Integer- Readonly
Property ShiftKey The ShiftKeys required for the hotkey to be triggered
Example
desklet.HotKeys(0).ShiftKey
Return: String- Readonly
Property OnExecute The script that will be execute when the hotkey is triggered.
Example
value = desklet.HotKeys(0).Script
Return: String
IO Name Description
Method CreateDirectory Create a directory at the specified location.
Example
desklet.IO.CreateDirectory('c:\test')
Return: Bool
Parameters
DirectoryName String- Directory Name to create.
Method ExecuteCMD Execute a command line exec and use the call back. When executecmd is called it will create the reference, you need to. The call back must be defined with 1 string parameter. This string parameter will contain the output of the command everytime new output is sent.
Example
cmd = desklet.io.ExecuteCMD('cmd /k', 'cmdcallback') cmd.start()
Return: CMDExecute
Parameters
CMD String- CMD will contain the command that will be executed.
CALLBACK String- Callback is the event with 1 parameter that will be executed when an output is found in the command.
Method GetTextFile The the text value for the selected file
Example
value = desklet.IO.GetTextFile('test.txt')
Return: String/Text
Parameters
FileName String- The file name of the text file
Method GenerateUniqueName Generate a unique name using the GUID method.
Example
Result = desklet.IO.GenerateUniqueName()
Return: String
Method GetSkinCtrlPath Get the path for the control resources.
Example
value = desklet.IO.GetSkinCtrlPath()
Return: String
Method GetSkinPath Get the path for the skin directory
Example
value = desklet.IO.GetSkinPath()
Return: String
Method GetSkinResPath Get the path for the skin resource directory
Example
value = desklet.IO.GetSkinResPath()
Return: String
Method GetSystemDirectory Get a system defined directory in windows.
Example
value = desklet.IO.GetSystemDirectory()
Parameters
SystemType String- The system file type you want to get. MYDOCUMENTS, MYPICTURES, MYMUSIC, MYVIDEOS, DESKTOP
Method GetTmpPath Get the path for the temporary directory
Example
value = desklet.IO.GetTmpPath()
Return: String
Method GetUserDocumentPath Get the path for the user's My Documents folder
Example
value = desklet.IO.GetUserDocumentPath()
Return: String
Method ShellExecutes Shell execute. Wrapper for the windows API shell execute
Example
value = desklet.IO.SkellExecutes('notepad','','',1,'OPEN')
Parameters
FileName String- Filename
Parameters-Opt Default '' String- Parameters used for the file
Directory-Opt Default '' String- Directory
ShowCMD-Opt Default ShowNormal Integer- The show mode used for the execute. HIDE = 0, SHOWNORMAL = 1, NORMAL = 1, SHOWMINIMIZED = 2, SHOWMAXIMIZED = 3, MAXIMIZE = 3, SHOWNOACTIVATE = 4, SHOW = 5, MINIMIZE = 6, SHOWMINNOACTIVE = 7, SHOWNA = 8, RESTORE = 9, SHOWDEFAULT = 10
Operation-Opt Default Open String- Operation used for the shell execute. Default is OPEN
Method URLToFile Downloads the URL result to a File
Example
value = desklet.IO.URLToFile('www.test.com/index.html','c:\test')
Return: Bool
Parameters
URLPath String- URL Path that you wish to download from. This can also be an image.
FileName String- Destination Filename for the download.
Agentname (opt) String- Name of the agen used when connecting to the site.
Layers Name Description
Method Delete Delete the requested layer
Example
desklet.layers.delete(0)
Parameters
Name / Index String- The name of the layer you wish to delete
Method New Add new Layer
Example
desklet.layers.new('Name','src',10,10,0)
Return: Layer
Parameters
Name String- The name of the layer
Src String- The source of the layer
X Integer- X Position of the layer
Y Integer- Y Position of the layer
Side Byte- Side the layer will belong to
Property Count The number of layers in the desklet
Example
value = desklet.layers.count
Return: Integer
Property Item The name of the layer you wish to retrieve
Example
desklet.layers.item(0)
Return: Layer
Parameters
Name / Index String- The name of the layer you wish to get or the Index
Layer Name Description
Method CaptureMouse Capture all mouse events for this layer, ignore all other layers.
Example
layer.CaptureMouse()
Method LockUpdates This will stop all update changes from performing an update on the screen. Allows the user to set more than 1 property and then do 1 redraw afterwards
Example
layer.LockUpdates()
Method Redraw Redraw the layer on the desklet
Example
layer.Redraw90
Method MoveBottom Move the z-order of the layer to the bottom
Example
layer.movebottom()
Method MoveDown Move the z-order of the layer down
Example
layer.movedown()
Method MoveTop Move the z-order of the layer to the top
Example
layer.movetop()
Method MoveUp Move the z-order of the layer up
Example
layer.moveup()
Method SetHue Set the hue of the layer
Example
layer.sethue(100)
Parameters
Hue Integer- The value of the hue
Method SetSaturation Set the saturation of the layer
Example
layer.setsaturation(100)
Parameters
saturation Integer- The value of the saturation
Method Slide Set the start clip of the layer.
Example
If an image was 100x100 using the following would produce a slide up effect: SCoord[0,0,100,100] ECoord[0,85,100,185] ICoord[0,3,0,3] The slide would slide up 3 pixels till the ECoord is reached. layer.slide(scoord,ecoord,icoord,10)
Parameters
SCoord String/Array- 4 Dimensional Array or Comma delimited string. Representing the rectangular area in the image to start from, and going in the order of Left,Top,Right,Bottom
ECoord Rect area where to stop the slide effect. Left,Top,Right,Bottom
ICoord Incrementing value used on each delay till you reach the ECoord
Delay Integer- Delay in milliseconds used between each slide increment
Loop (opt) Number of times you want the slide to execute
ASync (opt) Do you want the slide to happen synchronously or asynchronously. Async will not wait for the slide to complete
Callback (opt) Callback event is triggered after the slide is complete
Method SlideShow This will allow you to have/create a slideshow of images.
Example
desklet.SlideShow('img|img2|img3',10,10)
Parameters
ImageList String- Image list delimited by | .
Delay Integer- Delay time in MS between each image.
Loop Integer- The number of times the entire slideshow will run. -1 will make it Infinit.
ASync (opt) Boolean- Do you want the slide to happen synchronously or asynchronously. Async will not wait for the slide to complete
Callback (opt) String- Callback event that is triggered once the slideshow is done.
Method SetColor Change the colors of all the pixels to the given color
Example
layer.setcolor('clred')
Parameters
Color The new color to be set.
Method UnlockUpdates Sets the updates back to default state. All layer changes cause a redraw of the layer.
Example
layer.unlockupdates()
Method UnCaptureMouse Release the Capture.
Example
layer.uncapturemouse()
Method UpdateWebImage Force the web image to be redownloaded.
Example
layer.updatewebimage()
Property Alpha The Alpha value of the layer
Example
layer.Alpha = 200
Return: Byte
Property Canvas Canvas can only be access if the src,dsrc or msrc is defined to be a !Canvas
Example
layer.canvas
Return: CanvasList
Property CenterSrc Center the image in the layer if the scale is not used.
Example
layer.CenterSrc = True
Return: Boolean
Property Clickable Write Only. Set if the layer is clickable or not.
Example
layer.Clickable = True
Return: Boolean
Property ClipSource Clip Source is a 4 dimensional array that contains the clip range of the drawing. The clip range is the rectangular area that will be used from the image to be drawn on the desklet.
Example
layer.ClipSource = '0,0,291,186'
Return: Array / String comman delimited
Property Cursor Cursor used when the mouse goes over the layer. Refer to XMLObject mousecursor for list of cursors
Example
layer.Cursor = 'crArrow'
Return: String
Property Data Extra Data that can be stored on a layer. This data is Autosaved on closeup if anything exists.
Example
layer.Data = True
Return: Variant
Property Down Down state of the layer. If the down state is true then it will always draw dsrc
Example
layer.Down = True
Return: Bool
Property dsrc Source image/text/xml used when the layer is in the down state
Example
layer.dsrc = 'img2'
Return: String
Property FontAA If text exists, this will set the font style for the desklet as anti-aliased or not.
Example
layer.FontAA = True
Return: Bool
Property FontAlignment FontAlignment used if the layer has text (L left, R right, C center, T top, M middle, B bottom)
Example
layer.FontAlignment = 'LT'
Return: String
Property FontColor FontColor used if the layer has text. This can be represented as a RGB value or "Delphi" color names. #FF000 would be the RGB value for Red
Example
layer.FontColor = 'clred'
Return: String
Property FontName FontName used if the layer has text
Example
layer.FontName = 'Arial'
Return: String
Property FontSize FontSize used if the layer has text
Example
layer.FontSize = 5
Return: Integer
Property FontStyle FontStyle used if the layer has text (B bold, I italic U underline, S strike-out)
Example
layer.dsrc = 'BUIS
Return: String
Property Height Height of the layer
Example
layer.Height = 100
Return: Integer
Property Image The image that will be used for layer. Same thing as src.
Example
layer.Image = 'image.png'
Return: String
Property ImageHeight Readonly- The height of the image in the layer.
Example
Val = layer.ImageHeight
Return: Boolean
Property ImageWidth Readonly- The width of the image in the layer.
Example
val = layer.ImageWidth
Return: Boolean
Property KeyBind The string value of the key that the layer will be bound to. This key will trigger the OnClick event if pressed
Example
layer.KeyBind = 'A'
Return: String
Property LayerSide The side which the layer belongs to.
Example
layer.Side = 0
Return: Byte
Property MaskMinValue Value used for the masking of the start range
Example
layer.MaskMinValue = 50
Return: Byte
Property MaskValue Value used for the masking
Example
layer.MaskValue = 100
Return: Byte
Property msrc Source image/text/xml used when the layer is in the mouse is over the layer
Example
layer.msrc = 'img2'
Return: String
Property Name Name of the layer
Example
val = layer.Name
Return: String (readonly)
Property OffSetX Offset X value of the layer
Example
layer.OffSetX = 10
Return: Integer
Property OffSetY Offset Y value of the layer
Example
layer.OffSetY = 10
Return: Integer
Property Rotation Set the rotation of the layer. It will always return 0 when reading
Example
layer.Rotation = 45
Return: Integer
Property Scale Set the image to scale or not to the entire layer width / height.
Example
layer.Scale = True
Return: Boolean
Property ScaleProportional Set the image to keep the scale ratio.
Example
layer.ScaleProportional = True
Return: Boolean
Property src Source image/text/xml used when the layer is in the up state
Example
layer.src = 'img2'
Return: String
Property Text The text will set the text value for the src property.
Example
layer.Text = 'Hello World'
Return: String
Property TextResize Make the image width/height FIT the entire text. Informatin will clip or scale.
Example
layer.TextResize = True;
Return: Boolean
Property Width Width of the layer
Example
layer.Width = 100
Return: Integer
Property X X Position of the layer
Example
layer.X = 10
Return: Integer
Property Y Y Position of the layer
Example
layer.Y = 10
Return: Integer
Property Visible Visible state of the control
Example
layer.Visible = true
Return: Bool
Event OnMouseClick Event fired when mouse click occurs on the layer
Example
layer.OnMouseClick = 'alert("on mouse click")'
Event OnMouseDown Event fired when mouse down button is pressed on the layer
Example
layer.OnMouseClick = 'alert("on mouse down")'
Event OnMouseEnter Event fired when mouse enters the layer
Example
layer.OnMouseClick = 'alert("on mouse enter")'
Event OnMouseExit Event fired when mouse exits the layer
Example
layer.OnMouseClick = 'alert("on mouse Exit")'
Event OnMouseRightClick Event fired when mouse right button is clicked on the layer
Example
layer.OnMouseClick = 'alert("on mouse right click")'
Event OnMouseScroll Event fired when mouse scroller is used while the mouse cursor is over the layer
Example
layer.OnMouseClick = 'alert("on mouse scroll")'
Event OnMouseUp Event fired when mouse button up occurs on the layer
Example
layer.OnMouseClick = 'alert("on mouse up")'
Event OnMouseMove Event fired when mouse movement is detected on the layer
Example
layer.OnMouseMove = 'alert("on mouse click")'
Menus Name Description
Method Delete Delete the requested menu
Example
value = desklet.menus.delete(0)
Parameters
Index Byte- The ID of the menu you wish to delete
Method New Add new Menu
Example
value = desklet.menus.new(1,true,'','')
Return: Menu
Parameters
ID Byte- The ID of the menu
IncludeDefault Boolean- Include the avedesk menu or not
OnBefore String- The onBeforePopup event
OnAfter String- The onBeforePopup event
Property Count The number of menus in the desklet
Example
value = desklet.menus.count()
Return: Integer
Property Item The ID of the menu you wish to retrieve
Example
value = desklet.xmls.delete(0)
Return: Menu
Parameters
Index Integer- The index of the main menu.
Menu Name Description
Property OnAfterPopup The onafterpopup event
Example
value = desklet.menu(0).onafterpopup = "alert('After Popup')"
Return: String
Property OnBeforePopup The onbeforepopup event
Example
value = desklet.menu(0).onafterpopup = "alert('Before Popup')"
Return: String
Property ID The ID of the menu
Example
value = desklet.menu(0).ID
Return: Byte- Readonly
Property ShowDefaultMenu Shows the AveDesk default menu (or not)
Example
desket.menu(0).ShowDefaultMenu = true
Return: Boolean
Property SubMenu List of submenu items
Example
value = desklet.menu(0).SubMenu
Return: MenuItems
MenuItems Name Description
Method Delete Delete the requested menu
Example
value = desklet.menus(0).submenu.Delete('Temp')
Parameters
Name String- The name or index of the menu you want to delete
Method New Add new Menu item
Example
value = desklet.menus(0).submenu.new('menuitem','','alert('onclick')',true,false)
Return: MenuItem
Parameters
Name String- The name/text of the menu item
MenuType String- Menu Item type
OnClick String- The onClick event
Enabled Boolean- Set if the menu item is enabled
Checked Boolean- Set if the menu item is checked
Property Count The number of submenu items in the main menu
Example
value = desklet.menus(0).submenu.count
Return: Integer
Property Item The position of the menu item you wish to retrieve
Example
value = desklet.menus(0).submenu.item(0)
Return: MenuItem
Parameters
Name / Index String- The name or index of the submenu item you want
MenuItem Name Description
Property Checked The checked state of the menuitem
Example
desklet.Menu(0).SubMenu(0).Checked = true
Return: Boolean
Property Enabled The enabled state of the menuitem
Example
desklet.Menu(0).SubMenu(0).Enabled = true
Return: Boolean
Property MenuType Menu type for the menuitem. (S - Separator, MB - Menubreak, MBB - Menubarbreak
Example
desklet.Menu(0).SubMenu(0).MenuType = MB
Return: String
Property Name The name/display of the menu item
Example
desklet.Menu(0).SubMenu(0).Name = 'Hello'
Return: String
Property OnClick The onclick event
Example
desklet.Menu(0).SubMenu(0).OnClick = 'Alert('Click')'
Return: String
Property SubMenu List of submenu a menu tems. Each menu item can also have a sub menu
Example
value = desklet.Menu(0).SubMenu(0).SubMenu
Return: MenuItems
Monitor Name Description
Property Left Left Pixel location of the monitor vs desklet.
Example
value = desklet.UI.monitors(0).Left
Return: Integer - Readonly
Property Height Height of the monitor
Example
value = desklet.UI.monitors(0).Height
Return: Integer - Readonly
Property IsPrimary Is the monitor the primary monitor
Example
value = desklet.UI.monitors(0).IsPrimary
Return: Boolean- Readonly
Property MonitorNum The monitor index number
Example
value = desklet.UI.monitors(0).MonitorNum
Return: Integer - Readonly
Property Top Top Pixel location of the monitor vs desklet.
Example
value = desklet.UI.monitors(0).Top
Return: Integer - Readonly
Property Width Width of the monitor
Example
value = desklet.UI.monitors(0).Width
Return: Integer - Readonly
Property WorkHeight The desktop work area height
Example
value = desklet.UI.monitors(0).WorkHeight
Return: Integer- Readonly
Property WorkLeft The desktop work area left pixel
Example
value = desklet.UI.monitors(0).WorkLeft
Return: Integer- Readonly
Property WorkTop The desktop work area top pixel
Example
value = desklet.UI.monitors(0).WorkTop
Return: Integer- Readonly
Property WorkWidth The desktop work area width
Example
value = desklet.UI.monitors(0).WorkWidth
Return: Integer- Readonly
Parameters Name Description
Method New Add new Parameter
Example
desklet.Parameters.new('Name','Value','Event')
Return: Parameter
Parameters
Name String- The name of the parameter
Value Variant- The value of the parameter
Event String- The event that will be triggered when the parameter is changed
Method Delete Delete the requested parameter
Example
value = desklet.parameters.delete(0)
Parameters
Name / Index String- The name of the parameter you wish to delete or Index
Property Count The number of parameter in the desklet
Example
value = desklet.parameters.count
Return: Integer
Property Item The name of the parameter you wish to retrieve
Example
value = desklet.parameters.item(0)
Return: Parameter
Parameters
Name/Index String- Name or index position of the parameter
Parameter Name Description
Property Name The name of the parameter
Example
value = Param.Name
Return: String
Property Saveable Set the parameter saveable or not
Example
param.saveable(true)
Return: Bool
Property Value The value of the parameter
Example
value = param.value
Return: String
Event OnUpdate Event fired when the parameter has changed value
Example
Param.OnUpdate = 'alert("Param Change")'
Pen Name Description
Property Color The color of the pen
Example
value = layer.canvas.src.pen.color
Return: Integer
Property Width The width of the pen. All drawing objects use the pen to draw. The width is what makes the lines thicker
Example
value = layer.canvas.src.pen.width
Return: Integer
PlugIns Name Description
Method Delete Delete the requested PlugIns
Example
desklet.PlugIns.Delete('SoundMix')
Parameters
Name String- The name of the Plugin you wish to delete
Method New Add new PlugIn
Example
desklet.Plugins('SoundMix','soundm.dll')
Return: Object- Plugin com interface is the result
Parameters
Name String- The name of the plugin
Path String- The path of the dll that contains the plugin.
Property Count The number of plugins in the desklet
Example
value = desklet.plugins.count
Return: Integer
Property Item The name the plugin you wish to use
Example
desklet.PlugIns('SoundMix')
Return: Object- PlugIn com interface is the result.
Parameters
Name String- The name of the plugin you wish
Sides Name Description
Method Delete Delete the requested side
Example
value = desklet.sides.delete(0)
Parameters
Index Integer- The index position of the side you want to delete
Method New Add new Side
Example
desklet.sides.new(100,100,10,10)
Return: Side
Parameters
Width Integer- The width of the desklet
Height Integer- The height of the desklet
CloseX Integer- X Position of the close button
CloseY Integer- Y Position of the close button
Property Count The number of sides in the desklet
Example
value = desklet.sides.count
Return: Integer
Property Item The ID of the side you wish to retrieve
Example
value = desklet.sides.item(0)
Return: Integer
Parameters
Index Integer- The index position of the side
Side Name Description
Method Reset Reset the side with the settings
Example
side.Reset()
Property CloseX The X position for the close icon
Example
side.CloseX = 10
Return: Integer
Property CloseY The Y position for the close icon
Example
side.CloseY = 10
Return: Integer
Property ID The ID of the side
Example
value = side.ID
Return: Integer
Property Height The height of the side
Example
side.Height = 100
Return: Integer
Property Width The width of the side
Example
side.width = 100
Return: Integer
Timers Name Description
Method Delete Delete the requested timer
Example
value = desklet.timers.delete(0)
Parameters
Name/Index String- The name or index of the timer you wish to delete
Method New Add new Timer
Example
value = desklet.timers.new('timer','1000','alert('timer')',0)
Return: Timer
Parameters
Name String- The name of the timer
Time String- Time used for the timer
Event String- The event that will be triggered when timer is triggered
TimerType Byte- The timer type used for the timer. Timer Type (0 Delay will time in Milliseconds, 1 Delay will time in Milliseconds and end itself after one execution, 2 Time/Date will execute once only, 3 Time/Date will execute all the time, 4 Cron will time in seconds (example: 1800 = every 30mins on the 30min mark, 5 is equal to 0 except the time is reset after each time the event is fired)Timer Type (0 Delay will time in Milliseconds, 1 Delay will time in Milliseconds and end itself after one execution, 2 Time/Date will execute once only, 3 Time/Date will execute all the time, 4 Cron will time in seconds (example: 1800 = every 30mins on the 30min mark, 5 is equal to 0 except the time is reset after each time the event is fired)
Property Count The number of timers in the desklet
Example
value = desklet.Timers.Count
Return: Integer
Property Item The name or index of the timer you wish to retrieve
Example
value = desklet.timers.item(0)
Return: Timer
Parameters
Name / Index String- The name of the index of the timerl you wish to get
Timer Name Description
Method ResetTimer Reset the timer back to 0 and activate it again if it was stopped
Example
Timer.ResetTimer()
Method StopTimer Stop the timer
Example
timer.stoptimer()
Property Delay The delay of the timer
Example
timer.delay = 100
Return: String
Property Name The name of the timer
Example
value = param.name
Return: String
Property TimerType The type of timer. Refer to XML for the different types
Example
param.timertype = 0
Return: String
Event OnTimer Event fired when the timer is triggered
Example
timer.ontimer = 'alert("On Timer")'
UI Name Description
Method ColorToStr Convert the numeric color value to a string value
Example
value = desklet.UI.ColorToStr(242424)
Return: String
Parameters
Color String- This will contain the color in string format
Method Desktop Get the desktop information
Example
value = desklet.UI.Desktop
Return: Desktop
Method FindWindow Find a windows application window. If the window is found it will return the handle of the window
Example
desklet.UI.FindWindow('classname','windowname')
Return: Handle
Parameters
ClassName String- Class Name of the window
WindowName String- Window name that you are searching for.
Method FormateDateTime Create a formated date / time using windows settings.
Example
value = desklet.UI.Formate(2006,03,20,11,01,20,00,'dddddd')
Return: String
Parameters
YY Integer- Year.
MM Integer- Month.
DD Integer- Day.
HH Integer- Hour.
MT Integer- Minute.
SS Integer- Seconds.
MS Integer- MilliSec.
Format String- Format used to create the result. c Displays the date using the format given by the ShortDateFormat global variable, followed by the time using the format given by the LongTimeFormat global variable. The time is not displayed if the date-time value indicates midnight precisely. d Displays the day as a number without a leading zero (1-31). dd Displays the day as a number with a leading zero (01-31). ddd Displays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable. dddd Displays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable. ddddd Displays the date using the format given by the ShortDateFormat global variable. dddddd Displays the date using the format given by the LongDateFormat global variable. e Displays the year in the current period/era as a number without a leading zero (Japanese, Korean and Taiwanese locales only). ee Displays the year in the current period/era as a number with a leading zero (Japanese, Korean and Taiwanese locales only). g Displays the period/era as an abbreviation (Japanese and Taiwanese locales only). gg Displays the period/era as a full name. (Japanese and Taiwanese locales only). m Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed. mm Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed. mmm Displays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable. mmmm Displays the month as a full name (January-December) using the strings given by the LongMonthNames global variable. yy Displays the year as a two-digit number (00-99). yyyy Displays the year as a four-digit number (0000-9999). h Displays the hour without a leading zero (0-23). hh Displays the hour with a leading zero (00-23). n Displays the minute without a leading zero (0-59). nn Displays the minute with a leading zero (00-59). s Displays the second without a leading zero (0-59). ss Displays the second with a leading zero (00-59). z Displays the millisecond without a leading zero (0-999). zzz Displays the millisecond with a leading zero (000-999). t Displays the time using the format given by the ShortTimeFormat global variable. tt Displays the time using the format given by the LongTimeFormat global variab
Method GetWindowText Get the text in a window.
Example
value = desklet.UI.GetWindowText(handle)
Return: String
Parameters
hwnd Handle- Handle of the window you want to send the message to.
Method InputBox Prompt the user for a value
Example
value = desklet.UI.InputBox('Caption','Message prompt','DefaultVal')
Return: Text
Parameters
Caption String- Caption of the message box
Msg String- Message that is prompted to the user
Default String- Default value used for the input dialog
Method Monitor Get the monitor information for the selected monitor
Example
value = desklet.UI.Monitor(1)
Return: Monitor
Parameters
Item Integer- Index of the monitor you want to get information
Method MonitorCount Get the total count of monitors in your system
Example
desklet.UI.MonitorCount()
Return: Integer
Method PromptColor Prompt the user to select a color from a dialog box.
Example
value = desklet.UI.PromptColor()
Return: String
Method PromptDirectory Bring the directory dialog box that lets one select a file/folder. Returns the entire path of the new directory selected.
Example
value = desklet.UI.PromptDirectory('Message Prompt')
Return: String
Parameters
Message String- Message used in the dialog box.
Method PromptOpenFile Prompt the user to select a file. Returns the selected file
Example
value = desklet.UI.PromptOpenFile('c:\','*.exe','*.exe')
Return: String
Parameters
Directory (opt) String- Directory to start in
Filter (opt) String- Filter used in the dialog box. Example Text File|*.txt|Xml Files|*.xml
DefaultExt (opt) String- DefaultExt
Title (opt) String- Title in the caption bar
Method PromptSaveFile Prompt the user to select a file. Returns the selected file
Example
value = desklet.UI.PromptSaveFile('C:\')
Return: String
Parameters
Directory (opt) String- Directory to start in
Filter (opt) String- Filter used in the dialog box. Example Text File|*.txt|Xml Files|*.xml
DefaultExt (opt) String- DefaultExt
Title (opt) String- Title in the caption bar
Method SendWinMessage Send a windows message.
Example
value = desklet.UI.SendWinMessage(121312,123,0,0)
Return: Integer
Parameters
hwnd Handle- Handle of the window you want to send the message to.
Msg Unsigned Long- Message number used
wparam wparam- wparam value used
lparam lparam- lparam value used
Method SetCursor Set the window cursor
Example
desklet.UI.SetCursor('crArrow')
Parameters
Cursor String- This is the name of the cusor you want the computer system to be set at. The list available is the same list used in XML
Method StrToColor Convert a string color value to a numeric color value
Example
value = desklet.UI.ColorToStr(242424)
Return: Integer
Parameters
Color Integer- This will contain the integer color value
XMLs Name Description
Method Delete Delete the requested XML
Example
value = desklet.xmls.delete(0)
Parameters
Index Integer- The index of the XML you wish to delete
Method New Add new XML
Example
value = desklet.xmls.delete(0)
Return: XML
Parameters
src String- The source of the XML. Can be local or http.
time Integer- The time for auto refresh in minutes.
ongetdata String- The event that will be triggered when xml is fetched.
Property Count The number of XMLs in the desklet
Example
value = desklet.xmls.count()
Return: Integer
Property Item The ID of the XML you wish to retrieve
Example
desklet.xmls.item(0)
Return: XML
Parameters
Index Integer- Index of the xml you want to get
XML Name Description
Method ClearXML Clear the XML data.
Example
XML.ClearXML()
Method ForceGetData Force the xml to get new data and reset the timer
Example
XML.ForceGetData()
Method GetAgeOfXML Get the age of the XML File.
Example
value = control.GetAgeOfXML()
Return: Date
Method GetValue Get Value from xml data
Example
value = XML.GetValue('//node/name')
Return: String
Parameters
Path String- The Path in the xml that you wish to retrieve
Delimiter-Opt String- Delimiter used to separate the results. The default is a carriage return
PathIsXSL-Opt Bool- Is the path a XSL transformer. If the path is a file name use '!FILE:' prefix.
Method GetValueCount Get count of Values from xml data given the path
Example
value = XML.GetValueCount('//node/name')
Return: Integer
Parameters
Path The Path in the xml that you wish to retrieve
Method Reset Reset the XML data cache file.
Example
XML.Reset()
Method SaveXML Trigger the SAVE process of the XML
Example
XML.SaveXML('FileName')
Return: String
Parameters
NewFileName String- Filename for the new xml file if you don't use the current filename
Method WriteAttribValue Write an attribute value into the xml file.
Example
XML.WriteAttribValue('//Node/Name','Attrib','Value',0) //This will update/append the value
Return: Boolean
Parameters
Path String- Path in the xml that you wish to write to
Attribute String- Name of the attribute in the XML for the given path
Value String- Value to save in the XML file.
Mode Mode- Update/Append (0) or always append (1).
Method WriteTextValue Write a text value into the xml file. And return true/false if its done.
Example
XML.WriteTextValue('//node/name','value',0)
Return: Boolean
Parameters
Path String- Path in the xml that you wish to write to
Value String- Value to save in the XML file.
Mode Mode- Update/Append (0) or always append (1).
Property ID The ID of the XML
Example
value = XML.ID
Return: Integer-ReadOnly
Property Src Source of the XML
Example
xml.src = 'www.test.com/xml.rss'
Return: String
Property Time The time delay in minutes when the xml will auto fetch data from the source
Example
xml.time = 10
Return: Integer
Property UseWinTemp Sets the xml cache file to be stored in the Windows temp folder, or the internet temp folder
Example
xml.UseWinTemp = true
Return: Bool
Property IsDataOld This will return true if the XML data is older than the update timer.
Example
value = xml.isdataold
Return: Bool (readonly)
Property ReadOnly This will report if the XML file is readonly or not. Only local files can be have write access
Example
value = xml.ReadOnly
Return: Bool (readonly)
Event OnGetData The event triggered when the xml is data is loaded
Example
XML.OnGetData = 'alert("On XML Data")'